home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpedit.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  8.9 KB  |  219 lines
  1. <refentry id="libgimp-gimpedit" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpedit</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpedit</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-edit-cut">gimp_edit_cut</link>                   (<link linkend="gint32">gint32</link> drawable_ID);
  18. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-edit-copy">gimp_edit_copy</link>                  (<link linkend="gint32">gint32</link> drawable_ID);
  19. <link linkend="gint32">gint32</link>      <link linkend="gimp-edit-paste">gimp_edit_paste</link>                 (<link linkend="gint32">gint32</link> drawable_ID,
  20.                                              <link linkend="gboolean">gboolean</link> paste_into);
  21. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-edit-clear">gimp_edit_clear</link>                 (<link linkend="gint32">gint32</link> drawable_ID);
  22. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-edit-fill">gimp_edit_fill</link>                  (<link linkend="gint32">gint32</link> drawable_ID,
  23.                                              <link linkend="GimpFillType">GimpFillType</link> fill_type);
  24. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-edit-stroke">gimp_edit_stroke</link>                (<link linkend="gint32">gint32</link> drawable_ID);
  25. </synopsis>
  26. </refsynopsisdiv>
  27.  
  28.  
  29.  
  30.  
  31.  
  32. <refsect1>
  33. <title>Description</title>
  34. <para>
  35.  
  36. </para>
  37. </refsect1>
  38.  
  39. <refsect1>
  40. <title>Details</title>
  41. <refsect2>
  42. <title><anchor id="gimp-edit-cut">gimp_edit_cut ()</title>
  43. <programlisting><link linkend="gboolean">gboolean</link>    gimp_edit_cut                   (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  44. <para>
  45. Cut from the specified drawable.
  46. </para>
  47. <para>
  48. If there is a selection in the image, then the area specified by the
  49. selection is cut from the specified drawable and placed in an
  50. internal GIMP edit buffer. It can subsequently be retrieved using
  51. the 'gimp-edit-paste' command. If there is no selection, then the
  52. specified drawable will be removed and its contents stored in the
  53. internal GIMP edit buffer. The drawable MUST belong to the specified
  54. image, or an error is returned.</para>
  55. <para>
  56.  
  57. </para><informaltable pgwide=1 frame="none" role="params">
  58. <tgroup cols="2">
  59. <colspec colwidth="2*">
  60. <colspec colwidth="8*">
  61. <tbody>
  62. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  63. <entry> The drawable to cut from.
  64. </entry></row>
  65. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  66. </entry></row>
  67. </tbody></tgroup></informaltable></refsect2>
  68. <refsect2>
  69. <title><anchor id="gimp-edit-copy">gimp_edit_copy ()</title>
  70. <programlisting><link linkend="gboolean">gboolean</link>    gimp_edit_copy                  (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  71. <para>
  72. Copy from the specified drawable.
  73. </para>
  74. <para>
  75. If there is a selection in the image, then the area specified by the
  76. selection is copied from the specified drawable and placed in an
  77. internal GIMP edit buffer. It can subsequently be retrieved using
  78. the 'gimp-edit-paste' command. If there is no selection, then the
  79. specified drawable's contents will be stored in the internal GIMP
  80. edit buffer. The drawable MUST belong to the specified image, or an
  81. error is returned.</para>
  82. <para>
  83.  
  84. </para><informaltable pgwide=1 frame="none" role="params">
  85. <tgroup cols="2">
  86. <colspec colwidth="2*">
  87. <colspec colwidth="8*">
  88. <tbody>
  89. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  90. <entry> The drawable to copy from.
  91. </entry></row>
  92. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  93. </entry></row>
  94. </tbody></tgroup></informaltable></refsect2>
  95. <refsect2>
  96. <title><anchor id="gimp-edit-paste">gimp_edit_paste ()</title>
  97. <programlisting><link linkend="gint32">gint32</link>      gimp_edit_paste                 (<link linkend="gint32">gint32</link> drawable_ID,
  98.                                              <link linkend="gboolean">gboolean</link> paste_into);</programlisting>
  99. <para>
  100. Paste buffer to the specified drawable.
  101. </para>
  102. <para>
  103. This procedure pastes a copy of the internal GIMP edit buffer to the
  104. specified drawable. The GIMP edit buffer will be empty unless a call
  105. was previously made to either 'gimp-edit-cut' or 'gimp-edit-copy'.
  106. The \"paste_into\" option specifies whether to clear the current
  107. image selection, or to paste the buffer \"behind\" the selection.
  108. This allows the selection to act as a mask for the pasted buffer.
  109. Anywhere that the selection mask is non-zero, the pasted buffer will
  110. show through. The pasted buffer will be a new layer in the image
  111. which is designated as the image floating selection. If the image
  112. has a floating selection at the time of pasting, the old floating
  113. selection will be anchored to it's drawable before the new floating
  114. selection is added. This procedure returns the new floating layer.
  115. The resulting floating selection will already be attached to the
  116. specified drawable, and a subsequent call to floating_sel_attach is
  117. not needed.</para>
  118. <para>
  119.  
  120. </para><informaltable pgwide=1 frame="none" role="params">
  121. <tgroup cols="2">
  122. <colspec colwidth="2*">
  123. <colspec colwidth="8*">
  124. <tbody>
  125. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  126. <entry> The drawable to paste to.
  127. </entry></row>
  128. <row><entry align="right"><parameter>paste_into</parameter> :</entry>
  129. <entry> Clear selection, or paste behind it?
  130. </entry></row>
  131. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The new floating selection.
  132. </entry></row>
  133. </tbody></tgroup></informaltable></refsect2>
  134. <refsect2>
  135. <title><anchor id="gimp-edit-clear">gimp_edit_clear ()</title>
  136. <programlisting><link linkend="gboolean">gboolean</link>    gimp_edit_clear                 (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  137. <para>
  138. Clear selected area of drawable.
  139. </para>
  140. <para>
  141. This procedure clears the specified drawable. If the drawable has an
  142. alpha channel, the cleared pixels will become transparent. If the
  143. drawable does not have an alpha channel, cleared pixels will be set
  144. to the background color. This procedure only affects regions within
  145. a selection if there is a selection active.</para>
  146. <para>
  147.  
  148. </para><informaltable pgwide=1 frame="none" role="params">
  149. <tgroup cols="2">
  150. <colspec colwidth="2*">
  151. <colspec colwidth="8*">
  152. <tbody>
  153. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  154. <entry> The drawable to clear from.
  155. </entry></row>
  156. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  157. </entry></row>
  158. </tbody></tgroup></informaltable></refsect2>
  159. <refsect2>
  160. <title><anchor id="gimp-edit-fill">gimp_edit_fill ()</title>
  161. <programlisting><link linkend="gboolean">gboolean</link>    gimp_edit_fill                  (<link linkend="gint32">gint32</link> drawable_ID,
  162.                                              <link linkend="GimpFillType">GimpFillType</link> fill_type);</programlisting>
  163. <para>
  164. Fill selected area of drawable.
  165. </para>
  166. <para>
  167. This procedure fills the specified drawable with the fill mode. If
  168. the fill mode is foreground, the current foreground color is used.
  169. If the fill mode is background, the current background color is
  170. used. Other fill modes should not be used. This procedure only
  171. affects regions within a selection if there is a selection active.</para>
  172. <para>
  173.  
  174. </para><informaltable pgwide=1 frame="none" role="params">
  175. <tgroup cols="2">
  176. <colspec colwidth="2*">
  177. <colspec colwidth="8*">
  178. <tbody>
  179. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  180. <entry> The drawable to fill to.
  181. </entry></row>
  182. <row><entry align="right"><parameter>fill_type</parameter> :</entry>
  183. <entry> The type of fill.
  184. </entry></row>
  185. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  186. </entry></row>
  187. </tbody></tgroup></informaltable></refsect2>
  188. <refsect2>
  189. <title><anchor id="gimp-edit-stroke">gimp_edit_stroke ()</title>
  190. <programlisting><link linkend="gboolean">gboolean</link>    gimp_edit_stroke                (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  191. <para>
  192. Stroke the current selection
  193. </para>
  194. <para>
  195. This procedure strokes the current selection, painting along the
  196. selection boundary with the active brush and foreground color. The
  197. paint is applied to the specified drawable regardless of the active
  198. selection.</para>
  199. <para>
  200.  
  201. </para><informaltable pgwide=1 frame="none" role="params">
  202. <tgroup cols="2">
  203. <colspec colwidth="2*">
  204. <colspec colwidth="8*">
  205. <tbody>
  206. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  207. <entry> The drawable to stroke to.
  208. </entry></row>
  209. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  210. </entry></row>
  211. </tbody></tgroup></informaltable></refsect2>
  212.  
  213. </refsect1>
  214.  
  215.  
  216.  
  217.  
  218. </refentry>
  219.